/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.shardingsphere.db.protocol.mysql.packet.binlog.row.column.value;

import org.apache.shardingsphere.db.protocol.mysql.packet.binlog.row.column.MySQLBinlogColumnDef;
import org.apache.shardingsphere.db.protocol.mysql.packet.command.query.binary.execute.protocol.MySQLBinaryProtocolValue;
import org.apache.shardingsphere.db.protocol.mysql.payload.MySQLPacketPayload;

import java.io.Serializable;

/**
 * MySQL binlog protocol column value.
 *
 * <p>
 *     There are no detail documents about the value in row-based replication protocol.
 *     And many types of value protocol are different with {@link MySQLBinaryProtocolValue}
 * </p>
 */
public interface MySQLBinlogProtocolValue {
    
    /**
     * Read column value from binlog protocol.
     *
     * @param columnDef column definition from TABLE_MAP_EVENT
     * @param payload payload operation for MySQL binlog packet
     * @return column value
     */
    Serializable read(MySQLBinlogColumnDef columnDef, MySQLPacketPayload payload);
}
